docs(app): add frontend ARCHITECTURE.md and refresh project-guide section#8596
Merged
Conversation
…tion - app/ARCHITECTURE.md: directory layout, conventions (src/ alias, paths registry, lib/api client, theme tokens), data flow, testing pattern, quality gates, and how-to-add recipes - project-guide.md frontend section now lists the full gate (lint, fm:check, type-check incl. tests, test) and links the new architecture doc Part 11 of the frontend modernization roadmap. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds/refreshes frontend documentation to close out the “frontend modernization roadmap” by documenting the current app structure, conventions, and the local/CI quality gates.
Changes:
- Add
app/ARCHITECTURE.mddescribing frontend directory layout, conventions, data flow, testing approach, and “how to add” recipes. - Update
agentic/docs/project-guide.mdfrontend section to reflect the current gate commands and link to the new architecture doc.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| app/ARCHITECTURE.md | New frontend architecture/conventions doc; needs a few wording corrections to match current code/CI behavior. |
| agentic/docs/project-guide.md | Updates frontend dev guidance (lint/format/type-check/tests) and links to the architecture doc. |
Comment on lines
+42
to
+43
| - **Imports** are absolute from the `src/` alias (`import { paths } from 'src/routes/paths'`); | ||
| no relative `../` imports. ESLint (perfectionist) enforces sorted, grouped imports. |
Owner
Author
There was a problem hiding this comment.
Applied — reworded to 'no relative imports between src/ modules' with the package.json exception called out.
Comment on lines
+80
to
+82
| CI (`.github/workflows/ci-tests.yml`, job `test-frontend`) runs the same gates; | ||
| `yarn type-check` covers app and test files (`tsconfig.test.json`). During | ||
| development, `vite-plugin-checker` surfaces TS/ESLint errors in the browser. |
Owner
Author
There was a problem hiding this comment.
Applied — the doc now states CI runs lint/format/type-check/tests while yarn build runs in the Cloud Build Docker build on merge.
Comment on lines
+48
to
+49
| - **API access** goes through `src/lib/api` (`apiGet`/`apiPost` + `endpoints`); | ||
| raw `fetch()` lives only inside that module. Callers own caching/abort/dedup. |
Owner
Author
There was a problem hiding this comment.
Applied — scoped the rule to the anyplot backend and documented the external-API exception (useLatestRelease).
Comment on lines
+45
to
+47
| - **URLs** never appear as string literals in components — use `paths.*` from | ||
| `src/routes/paths` (static routes, `paths.plotsFiltered(param, value)`, | ||
| `paths.spec(specId, language, library)`). |
Owner
Author
There was a problem hiding this comment.
Applied in code rather than softening the doc — MastheadRule breadcrumbs, the routes redirect, and SpecPage pageview tracking now use specPath; no route string literals remain in components.
…pen docs Copilot review findings on the architecture doc — three doc/reality gaps closed by precision wording (src-internal import rule, lib/api scope incl. the external GitHub-API exception, CI-vs-Cloud-Build gate split) and one by code: MastheadRule breadcrumbs, the routes redirect, and SpecPage pageview tracking now build spec URLs via specPath instead of template literals. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
MarkusNeusinger
added a commit
that referenced
this pull request
Jun 10, 2026
Version bump for the v3.0.0 release. Full release notes will be attached to the tag once this lands (draft release already prepared). ## Why a major version - **Highcharts Python → JavaScript was a clean break** (#8516): all 322 legacy `highcharts.py` implementations were removed and replaced by native `highcharts.js` 12.6.0. - The catalog scope changed fundamentally: **2 → 4 languages, 10 → 15 libraries**. - The **Imprint palette** replaced Okabe-Ito in every implementation — a complete visual identity change. ## Highlights since v2.4.0 - **Julia / Makie.jl added as the 3rd language** (#7613) — 74 implementations. - **JavaScript added as the 4th language** with Chart.js, D3.js, Apache ECharts and a Node 22 + Playwright browser render harness emitting PNG + interactive HTML (#8244, #8251). - **MUI X Charts** as the first React/TSX library (#8517). - **Highcharts migrated to native JavaScript** (clean break, #8516). - **Imprint palette**: 8 colorblind-safe hues + 3 semantic anchors; ~1,300 implementations migrated in one wave (#7692, #7776–#7798); `/palette` page rebuilt with OKLCH wheel + ΔE matrices (#8125). - **Frontend modernization**: 11-PR restructure of `app/` + CI lint/format/type-check gates + `ARCHITECTURE.md` (#8519–#8596). - **Render quality**: canvas halved to 3200×1800 / 2400×2400 (#7387), hard canvas-size gate (#7517), AR-09 edge-clipping auto-reject (#7528). - **Pipeline**: watchdog rescues 3 more stuck-PR failure modes (#7687), daily-regen 10×/day on Sonnet (#7717, #7286), alembic dual-head fix for Postgres sync (#7285). - 885 regenerations + 310 new implementations; 21 dependency updates. Known follow-up (not in this PR): `highcharts-core` is still listed in `pyproject.toml` although the Python wrapper is no longer used (deferred in #8516). **Full Changelog:** v2.4.0...main 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Part 11 (final) of the frontend modernization roadmap.
app/ARCHITECTURE.md: directory layout (routes/layouts/pages/sections/components/hooks/lib/theme), conventions (src/alias imports,paths.*URL registry,lib/apiclient, theme tokens, feature folders), data flow, testing pattern, quality gates, and how-to-add recipes for pages/sections/hooks/endpointsagentic/docs/project-guide.md: frontend section now lists the full gate (lint,fm:check,type-checkincl. tests,test), mentions the dev-time checker overlay, and links the new architecture docWith this, the roadmap is complete: tooling baseline (#8519), src/ aliases (#8520), theme split (#8525), global-config (#8529), API client (#8531), routes registry (#8546), structure split (#8547), FilterBar (#8559), SpecTabs (#8564), MapPage hook (#8581).
🤖 Generated with Claude Code